<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->
<!-- $Id: package.html 561230 2007-07-31 04:17:09Z rahul $ -->
<html>
  <head>
    <title>Overview of the org.apache.commons.fileupload.disk component</title>
  </head>
  <body>
    <p>
      A disk-based implementation of the
      {@link org.apache.commons.fileupload.FileItem FileItem}
      interface. This implementation retains smaller items in memory, while
      writing larger ones to disk. The threshold between these two is
      configurable, as is the location of files that are written to disk.
    </p>
    <p>
      In typical usage, an instance of
      {@link org.apache.commons.fileupload.disk.DiskFileItemFactory DiskFileItemFactory}
      would be created, configured, and then passed to a
      {@link org.apache.commons.fileupload.FileUpload FileUpload}
      implementation such as
      {@link org.apache.commons.fileupload.servlet.ServletFileUpload ServletFileUpload}
      or
      {@link org.apache.commons.fileupload.portlet.PortletFileUpload PortletFileUpload}.
    </p>
    <p>
      The following code fragment demonstrates this usage.
    </p>
<pre>
        DiskFileItemFactory factory = new DiskFileItemFactory();
        // maximum size that will be stored in memory
        factory.setSizeThreshold(4096);
        // the location for saving data that is larger than getSizeThreshold()
        factory.setRepository(new File("/tmp"));

        ServletFileUpload upload = new ServletFileUpload(factory);
</pre>
    <p>
      Please see the FileUpload
      <a href="http://commons.apache.org/fileupload/using.html" target="_top">User Guide</a>
      for further details and examples of how to use this package.
    </p>
  </body>
</html>
